<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title>Docs For Class Codec</title>
  <link rel="stylesheet" href="../media/stylesheet.css" />
  <script src="../media/lib/classTree.js"></script>
<link id="webfx-tab-style-sheet" type="text/css" rel="stylesheet" href="../media/lib/tab.webfx.css" />
<script type="text/javascript" src="../media/lib/tabpane.js"></script>
  <script language="javascript" type="text/javascript" src="../media/lib/ua.js"></script>
<script language="javascript" type="text/javascript">
	var imgPlus = new Image();
	var imgMinus = new Image();
	imgPlus.src = "../media/images/plus.gif";
	imgMinus.src = "../media/images/minus.gif";
	
	function showNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgMinus.src;
		oTable.style.display = "block";
	}
	
	function hideNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgPlus.src;
		oTable.style.display = "none";
	}
	
	function nodeIsVisible(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
        		break;
        }
		return (oTable && oTable.style.display == "block");
	}
	
	function toggleNodeVisibility(Node){
		if (nodeIsVisible(Node)){
			hideNode(Node);
		}else{
			showNode(Node);
		}
	}
</script>
<!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
<body bgcolor="#ffffff" ><!-- Start of Class Data -->
<h2>
	Class Codec
</h2> (line <span class="linenumber">51</span>)
<div class="tab-pane" id="tabPane1">
<script type="text/javascript">
tp1 = new WebFXTabPane( document.getElementById( "tabPane1" ));
</script>

<div class="tab-page" id="Description">
<h2 class="tab">Description</h2>
<pre>
</pre>
<p>
	<b><i>Located in File: <a href="_codecs---Codec.php.html">/codecs/Codec.php</a></i></b><br>
</p>
<!-- ========== Info from phpDoc block ========= -->
<h5>The Codec interface defines a set of methods for encoding and decoding</h5>
<div class="desc"><p>application level encoding schemes, such as HTML entity encoding and percent  encoding (aka URL encoding). Codecs are used in output encoding and  canonicalization.  The design of these codecs allows for  character-by-character decoding, which is necessary to detect double-encoding  and the use of multiple encoding schemes, both of which are techniques used  by attackers to bypass validation and bury encoded attacks in data.</p></div>
<ul>
		<li><strong>author:</strong> - Mike Boberski &lt;<a href="mailto:boberski_michael@bah.com">boberski_michael@bah.com</a>&gt;</li>
		<li><strong>author:</strong> - Linden Darling &lt;<a href="mailto:Linden.Darling@jds.net.au">Linden.Darling@jds.net.au</a>&gt;</li>
		<li><strong>author:</strong> - jah &lt;<a href="mailto:jah@jahboite.co.uk">jah@jahboite.co.uk</a>&gt;</li>
		<li><strong>version:</strong> - Release: @package_version@</li>
		<li><strong>copyright:</strong> - 2009-2010 The OWASP Foundation</li>
		<li><strong>link:</strong> - <a href="http://www.owasp.org/index.php/ESAPI">http://www.owasp.org/index.php/ESAPI</a></li>
		<li><strong>abstract:</strong> - </li>
		<li><strong>license:</strong> - <a href="http://www.opensource.org/licenses/bsd-license.php">New BSD license</a></li>
	</ul>
<br /><hr />
<span class="type">Classes extended from Codec:</span>
 		<dl>
	<dt><a href="../ESAPI_Codecs/Base64Codec.html">Base64Codec</a></dt>
		<dd>Reference implementation of the base 64 codec.</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/CSSCodec.html">CSSCodec</a></dt>
		<dd>Reference implementation of the CSS codec.</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/HTMLEntityCodec.html">HTMLEntityCodec</a></dt>
		<dd>Reference implementation of the HTML entity codec.</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/JavaScriptCodec.html">JavaScriptCodec</a></dt>
		<dd>Reference implementation of the JavaScriptCodec codec.</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/MySQLCodec.html">MySQLCodec</a></dt>
		<dd>Reference implementation of the CSS codec.</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/OracleCodec.html">OracleCodec</a></dt>
		<dd>Reference implementation of the CSS codec.</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/PercentCodec.html">PercentCodec</a></dt>
		<dd>Reference implementation of the CSS codec.</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/UnixCodec.html">UnixCodec</a></dt>
		<dd>Reference implementation of the Unix codec.</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/VBScriptCodec.html">VBScriptCodec</a></dt>
		<dd>Reference implementation of the CSS codec.</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/WindowsCodec.html">WindowsCodec</a></dt>
		<dd>Reference implementation of the Windows codec.</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Reference_Validation/XMLEntityCodec.html">XMLEntityCodec</a></dt>
		<dd>Extension of the abstract class Codec for XML entity encoding.</dd>
	</dl>
	</p>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "Description" ) );</script>
<div class="tab-page" id="tabPage1">

<h2 class="tab">Class Variables</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage1" ) );</script>
</div>
<div class="tab-page" id="constantsTabpage">

<h2 class="tab">Class Constants</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "constantsTabpage" ) );</script>
</div>
<div class="tab-page" id="tabPage2">
<h2 class="tab">Method Detail</h2>
<!-- ============ METHOD DETAIL =========== -->
<strong>Summary:</strong><br />
<div class="method-summary">
    <div class="method-definition">
    static         <span class="method-result">string</span>
        <a href="#methodcontainsCharacter" title="details" class="method-name">containsCharacter</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$c</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$array</span>)
        </div>
    <div class="method-definition">
    static         <span class="method-result">string</span>
        <a href="#methoddetectEncoding" title="details" class="method-name">detectEncoding</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>)
        </div>
    <div class="method-definition">
    static         <span class="method-result">string</span>
        <a href="#methodforceToSingleCharacter" title="details" class="method-name">forceToSingleCharacter</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>)
        </div>
    <div class="method-definition">
    static         <span class="method-result">string</span>
        <a href="#methodgetHexForNonAlphanumeric" title="details" class="method-name">getHexForNonAlphanumeric</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$c</span>)
        </div>
    <div class="method-definition">
    static         <span class="method-result">string</span>
        <a href="#methodnormalizeEncoding" title="details" class="method-name">normalizeEncoding</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>)
        </div>
    <div class="method-definition">
    static         <span class="method-result">int</span>
        <a href="#methodtoHex" title="details" class="method-name">toHex</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$c</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">Codec</span>
        <a href="#method__construct" title="details" class="method-name">__construct</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methoddecode" title="details" class="method-name">decode</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$input</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodencode" title="details" class="method-name">encode</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$immune</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$input</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodencodeCharacter" title="details" class="method-name">encodeCharacter</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$immune</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$c</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">bool</span>
        <a href="#methodisHexDigit" title="details" class="method-name">isHexDigit</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$c</span>)
        </div>
</div>
<hr />
<A NAME='method_detail'></A>


<a name="methodcontainsCharacter" id="methodcontainsCharacter"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Static Method containsCharacter</strong> (line <span class="linenumber">388</span>)
 </h4> 
<h4><i>string</i> <strong>containsCharacter(
string
$c, array
$array)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Utility to search a char[] for a specific char.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $c</strong>: character to search for</li>
			<li><strong>array $array</strong>: character array to search in</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - returns specific character</li>
			<li><strong>access</strong> - public</li>
		</ul>
</div>
<a name="methoddetectEncoding" id="methoddetectEncoding"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Static Method detectEncoding</strong> (line <span class="linenumber">426</span>)
 </h4> 
<h4><i>string</i> <strong>detectEncoding(
string
$string)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Utility to detect a (potentially multibyte) string's encoding with  extra logic to deal with single characters that mb_detect_encoding() fails  upon.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $string</strong>: string to examine</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - returns detected encoding</li>
			<li><strong>access</strong> - public</li>
		</ul>
</div>
<a name="methodforceToSingleCharacter" id="methodforceToSingleCharacter"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Static Method forceToSingleCharacter</strong> (line <span class="linenumber">515</span>)
 </h4> 
<h4><i>string</i> <strong>forceToSingleCharacter(
string
$string)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Utility to get first (potentially multibyte) character from a (potentially  multicharacter) multibyte string.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $string</strong>: string to convert</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - converted string</li>
			<li><strong>access</strong> - public</li>
		</ul>
</div>
<a name="methodgetHexForNonAlphanumeric" id="methodgetHexForNonAlphanumeric"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Static Method getHexForNonAlphanumeric</strong> (line <span class="linenumber">347</span>)
 </h4> 
<h4><i>string</i> <strong>getHexForNonAlphanumeric(
string
$c)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Returns the ordinal value as a hex string of any character that is not a  single-byte alphanumeric. The character should be supplied as a string in  the UTF-32 character encoding.</h5>
<div class="desc"><p>If the character is an alphanumeric character with ordinal value below  255 then this method will return null.</p></div>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $c</strong>: 4 byte character character.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - hexadecimal ordinal value of non-alphanumeric characters                 or null otherwise.</li>
			<li><strong>access</strong> - public</li>
		</ul>
</div>
<a name="methodnormalizeEncoding" id="methodnormalizeEncoding"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Static Method normalizeEncoding</strong> (line <span class="linenumber">495</span>)
 </h4> 
<h4><i>string</i> <strong>normalizeEncoding(
string
$string)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Utility to normalize a string's encoding to UTF-32.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $string</strong>: string to normalize</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - normalized string</li>
			<li><strong>access</strong> - public</li>
		</ul>
</div>
<a name="methodtoHex" id="methodtoHex"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Static Method toHex</strong> (line <span class="linenumber">372</span>)
 </h4> 
<h4><i>int</i> <strong>toHex(
string
$c)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Return the hex value of a character as a string without leading zeroes.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $c</strong>: character to convert</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - returns hex value</li>
			<li><strong>access</strong> - public</li>
		</ul>
</div>
<a name="method__construct" id="method__construct"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/Constructor.gif" border="0" /> <strong class="method">Constructor __construct</strong> (line <span class="linenumber">63</span>)
 </h4> 
<h4><i>Codec</i> <strong>__construct(
)</strong></h4>
	<p>Overridden in child classes as:<br />
		<dl>
	<dt><a href="../ESAPI_Codecs/Base64Codec.html#method__construct">Base64Codec::__construct()</a></dt>
		<dd>Public Constructor</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/CSSCodec.html#method__construct">CSSCodec::__construct()</a></dt>
		<dd>Public Constructor</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/HTMLEntityCodec.html#method__construct">HTMLEntityCodec::__construct()</a></dt>
		<dd>Public Constructor</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/JavaScriptCodec.html#method__construct">JavaScriptCodec::__construct()</a></dt>
		<dd>Public Constructor</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/MySQLCodec.html#method__construct">MySQLCodec::__construct()</a></dt>
		<dd>Public Constructor</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/OracleCodec.html#method__construct">OracleCodec::__construct()</a></dt>
		<dd>Public Constructor</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/PercentCodec.html#method__construct">PercentCodec::__construct()</a></dt>
		<dd>Public Constructor</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/UnixCodec.html#method__construct">UnixCodec::__construct()</a></dt>
		<dd>Public Constructor</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/VBScriptCodec.html#method__construct">VBScriptCodec::__construct()</a></dt>
		<dd>Public Constructor</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/WindowsCodec.html#method__construct">WindowsCodec::__construct()</a></dt>
		<dd>Public Constructor</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Reference_Validation/XMLEntityCodec.html#method__construct">XMLEntityCodec::__construct()</a></dt>
		<dd>Public Constructor calls the parent construcor and initialises the character  to entity and entity to character maps.</dd>
	</dl>
	</p>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Populates the $hex map of non-alphanumeric single-byte characters.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>access</strong> - public</li>
		</ul>
</div>
<a name="methoddecode" id="methoddecode"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method decode</strong> (line <span class="linenumber">142</span>)
 </h4> 
<h4><i>string</i> <strong>decode(
string
$input)</strong></h4>
	<p>Overridden in child classes as:<br />
		<dl>
	<dt><a href="../ESAPI_Codecs/Base64Codec.html#methoddecode">Base64Codec::decode()</a></dt>
		<dd>Decodes the given input string from Base64 to plain text.</dd>
	</dl>
	</p>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Decode a String that was encoded using the encode method in this Class</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $input</strong>: the String to decode</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - returns the decoded string, otherwise null</li>
		</ul>
</div>
<a name="methodencode" id="methodencode"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method encode</strong> (line <span class="linenumber">85</span>)
 </h4> 
<h4><i>string</i> <strong>encode(
string
$immune, string
$input)</strong></h4>
	<p>Overridden in child classes as:<br />
		<dl>
	<dt><a href="../ESAPI_Codecs/Base64Codec.html#methodencode">Base64Codec::encode()</a></dt>
		<dd>Encodes the input string to Base64.</dd>
	</dl>
	</p>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Encode a String with a Codec.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $immune</strong>: immune characters</li>
			<li><strong>string $input</strong>: the String to encode.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the encoded string.</li>
			<li><strong>access</strong> - public</li>
		</ul>
</div>
<a name="methodencodeCharacter" id="methodencodeCharacter"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method encodeCharacter</strong> (line <span class="linenumber">115</span>)
 </h4> 
<h4><i>string</i> <strong>encodeCharacter(
string
$immune, string
$c)</strong></h4>
	<p>Overridden in child classes as:<br />
		<dl>
	<dt><a href="../ESAPI_Codecs/Base64Codec.html#methodencodeCharacter">Base64Codec::encodeCharacter()</a></dt>
		<dd>Encodes a single character to Base64.</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/CSSCodec.html#methodencodeCharacter">CSSCodec::encodeCharacter()</a></dt>
		<dd></dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/HTMLEntityCodec.html#methodencodeCharacter">HTMLEntityCodec::encodeCharacter()</a></dt>
		<dd></dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/JavaScriptCodec.html#methodencodeCharacter">JavaScriptCodec::encodeCharacter()</a></dt>
		<dd>Returns backslash encoded numeric format. Does not use backslash  character escapes such as, \&quot; or \' as these may cause parsing problems.</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/MySQLCodec.html#methodencodeCharacter">MySQLCodec::encodeCharacter()</a></dt>
		<dd></dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/OracleCodec.html#methodencodeCharacter">OracleCodec::encodeCharacter()</a></dt>
		<dd></dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/PercentCodec.html#methodencodeCharacter">PercentCodec::encodeCharacter()</a></dt>
		<dd></dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/UnixCodec.html#methodencodeCharacter">UnixCodec::encodeCharacter()</a></dt>
		<dd></dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/VBScriptCodec.html#methodencodeCharacter">VBScriptCodec::encodeCharacter()</a></dt>
		<dd></dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Codecs/WindowsCodec.html#methodencodeCharacter">WindowsCodec::encodeCharacter()</a></dt>
		<dd></dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI_Reference_Validation/XMLEntityCodec.html#methodencodeCharacter">XMLEntityCodec::encodeCharacter()</a></dt>
		<dd></dd>
	</dl>
	</p>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Encode a Character with a Codec.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $immune</strong>: immune characters</li>
			<li><strong>string $c</strong>: the Character to encode.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the encoded Character.</li>
			<li><strong>access</strong> - public</li>
		</ul>
</div>
<a name="methodisHexDigit" id="methodisHexDigit"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isHexDigit</strong> (line <span class="linenumber">530</span>)
 </h4> 
<h4><i>bool</i> <strong>isHexDigit(
string
$c)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Utility method to determine if a single character string is a hex digit</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $c</strong>: Single character string that is potentially a hex digit</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - True indicates that the single character string is a hex               digit</li>
		</ul>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage2" ) );</script></div>
<div class="tab-page" id="iVars">
<h2 class="tab">Inherited Variables</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iVars" ) );</script>
<!-- =========== VAR INHERITED SUMMARY =========== -->
<A NAME='var_inherited_summary'><!-- --></A>
<h3>Inherited Class Variable Summary</h3>

	</div>
<div class="tab-page" id="iMethods">
<h2 class="tab">Inherited Methods</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iMethods" ) );</script>
<!-- =========== INHERITED METHOD SUMMARY =========== -->
<A NAME='functions_inherited'><!-- --></A>
<h3>Inherited Method Summary</h3>

	</div>
</div>
<script type="text/javascript">
//<![CDATA[

setupAllTabs();

//]]>
</script>
	<div id="credit">
		<hr />
		Documentation generated on Fri, 21 May 2010 14:53:31 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</div>
</body>
</html>